/* Gauge - Performance Measurement Framework for Mobile Platforms
 * Copyright (C) 2013, Juha Hytonen <juha.a.hytonen@gmail.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.gauge;

import java.io.File;

/**
 * The base class for all file based measurement storages.
 *
 * AbstractFileMeasurementStorage uses FileManager to manage a measurement
 * storage  file and provides convenience methods for writing into it.
 * 
 * Override addMeasurement() in your implementation to handle measurements.
 * 
 * @see FileManager
 * @see MeasurementStorage
 */
public abstract class AbstractFileMeasurementStorage extends MeasurementStorage {
	
	private FileManager fileManager;

	public AbstractFileMeasurementStorage(File file) throws Exception {
		fileManager = new FileManager(file);
	}
	
	@Override
	protected void close() throws Exception {
		fileManager.Close();
	}
	
	/**
	 * Writes given line into the log file. Line break is automatically appended.
	 */
	protected final void writeLine(String line) throws Exception {
		fileManager.WriteLine(line);
	}
	
	/**
	 * Writes given data into the log file. No line break is appended.
	 */
	protected final void write(String data) throws Exception {
		fileManager.Write(data);
	}

}
